Skip to main content

HaloPesa Statement Analysis​

POST https://api.sat.tausi.africa/v1/halopesa/upload_halopesa_pdf

This analyses the pdf and generates the report. The response is in a json format.

Header Requirements​

  • Authorization --required

Body Params​

  • file --required
  • fullname --required
curl example request
curl -X 'POST' 'https://api.sat.tausi.africa/v1/halopesa/upload_halopesa_pdf'
 -F fullname=Hussein \ 
 -F 'file=@HaloPesa_4435535_Statement.pdf' \
 -H 'Authorization: Bearer XXXXXXXXXXX' \'

Response Sample​

  1. Status OK Response
200 OK
{
    "info": {
        "owners_number": "25561XXXXXXX",
        "start_date": "2023-12-17 19:50:19",
        "end_date": "2024-03-11 00:01:54",
        "total_days": 85,
        "total_active_days": 40
    },
    "profile": {
        "current_balance": 3610.0,
        "turnover": 6367402.0,
        "number_of_transactions": 137
    },
    "cashin_flow": {
        "total_cash-in_flow": 3183756.0,
        "cash-in_flow_to_turnover_percentage": 50.0,
        "cash-in_flow_transactions": 39,
        "cash-in_trans_to_total_trans_percentage": 28.47
    },
    "cashout_flow": {
        "Total_cash-out_flow": 3183646.0,
        "Cash-out_flow_to_turnover_percentage": 50.0,
        "Cash-out_flow_transactions": 98,
        "Cash-out_trans_to_total_trans_percentage": 71.53
    },
    "b2w": {
        "total_amount_transferred_from_bank_to_wallet": 504000.0,
        "maximum_amount_transferred_from_bank_to_wallet": 120000.0,
        "number_of_times_transferred_from_bank_to_wallet": 13,
        "average_amount_transferred_from_bank_to_wallet": 38769.23,
        "last_time_transferred_from_bank_to_wallet": "2024-01-26 23:09:00",
        "last_amount_transferred_from_bank_to_wallet": 14000.0
    },
    "w2b": {
        "total_amount_transferred_from_wallet_to_bank": 982000.0,
        "maximum_amount_transferred_from_wallet_to_bank": 444000.0,
        "number_of_times_trasnferred_from_wallet_to_bank": 5,
        "average_amount_transferred_from_wallet_to_bank": 196400.0,
        "last_time_transferred_from_wallet_to_bank": "2024-03-10 09:08:05",
        "last_amount_transferred_from_wallet_to_bank": 384000.0
    },
    "luku": {
        "total_amount_used_to_buy_luku": 34500.0,
        "maximum_amount_used_to_buy_luku": 20000.0,
        "number_of_times_bought_luku": 4,
        "average_amount_bought_luku": 8625.0,
        "last_time_bought_luku": "2024-01-24 12:38:33",
        "last_amount_bought_luku": 6500.0
    },
    "agent_deposit": {
        "total_amount_deposited": 110000.0,
        "max_amount_deposited": 110000.0,
        "number_of_times_deposited": 1,
        "average_amount_deposited": 110000.0,
        "last_day_deposited": "2024-01-17 12:28:54",
        "last_amount_deposited": 110000.0,
        "nunique_agents_deposited": 1
    },
    "agent_withdraw": {
        "total_amount_withdrawn_via_agent": 635918.0,
        "maximum_amount_withdrawn_via_agent": 336338.0,
        "number_of_times_withdrawn_via_agent": 11,
        "average_amount_withdrawn": 57810.73,
        "last_time_withdrawn_via_agent": "2024-01-23 15:08:05",
        "last_amount_withdrawn": 34151.0,
        "nunique_agents_withdrawn": 8
    },
    "money_sent_p2p": {
        "total_amount_sent_to_peer": 1145728.0,
        "max_amount_sent_to_peer": 104350.0,
        "number_of_times_sent_to_peer": 47,
        "average_amount_sent_to_peer": 24377.19,
        "last_day_sent_to_peer": "2024-03-11 00:01:54",
        "last_amount_sent_to_peer": 101350.0
    },
    "money_received_p2p": {
        "total_amount_received_from_peer": 2561006.0,
        "max_amount_received_from_peer": 800000.0,
        "number_of_times_received_from_peer": 24,
        "average_amount_received_from_peer": 106708.58,
        "last_day_received_from_peer": "2024-03-09 13:33:04",
        "last_amount_received_from_peer": 500000.0
    },
    "merchant_payments": {
        "total_amount_paid": 246000.0,
        "max_amount_paid": 66000.0,
        "number_of_times_paid": 5,
        "average_amount_paid": 49200.0,
        "last_day_paid": "2024-01-21 21:00:00",
        "last_amount_paid": 66000.0
    },
    "bundle": {
        "total_amount_spent_on_yatosha": 134500.0,
        "max_amount_spent_on_yatosha": 10000.0,
        "number_of_times_bought_yatosha": 25,
        "average_amount_spent_on_yatosha": 5380.0,
        "last_day_bought_yatosha": "2024-03-10 00:12:17",
        "last_amount_spent_on_yatosha": 5000.0
    }
}

  1. Bad Request Response
400 Bad Request
message: "<The specific error message>"

  1. Unprocessable Entity
422 Unprocessable file entity
message: "Unprocessable File Entity"

  1. Rate Limit Error
429 Rate Limited Error
message: "Rate limited resource",
nexttime:"19876543"

  1. Internal Server Error
500 Internal Server Error
message: "An Internal server error",

Rate Limiting!

Rate Limited Resource Continous Access will lead to blocking an account.